sdapiobject module

class sd.api.sdapiobject.SDAPIObject(APIContext, handle, *args, **kwargs)

Bases: object

Base class for all APIObjects

getClassName() → str

Returns the most specific name of the class this APIObject is

class sd.api.sdapiobject.SDApiError

Bases: enum.Enum

Enum representing error code from an API call

DataIsFunctionOnly = 17

Unable to read from device

DataIsReadOnly = 15

The Iray SDK data is not initialized properly (possible reasons: not supported by current platform; missing library; …)

IndexOutOfBounds = 5

Type conversion failed

InvalidArgument = 3

Insufficient memory

InvalidHandle = 9

The specified type is invalid

InvalidSubstanceEngine = 8

The handle is invalid

InvalidType = 10

The specified value is invalid

InvalidValue = 11

Not yet implemented

IrayNotInitialized = 16

The data is function readonly. his value is only controlled by a function. No getValue/setValue is allowed

ItemNotFound = 14

The data is readonly

MemoryAllocationFailed = 4

The specified index is out of bounds of the container

NoError = 0

API Call succeed but the output parameter has not been set

NoErrorOutputParamNotSet = 1

Undefined error

NotImplemented = 12

The operation is not supported by the object

NotSupported = 13

The specified item cannot be found

PackageNotSaved = 19

ReadFromDeviceFailed = 18

The package has not been saved already

TypeConversionFailed = 6

Unable to write on device (Possible reasons: device is readonly; the path does not exist; insufficient access rights, …

Undefined = 2

One or more of the specified arguments were invalid

WriteToDeviceFailed = 7

Substance Engine is invalid or can’t be found